Add ability for users to connect custom MCP tools as a connector to search spaces #688
Conversation
|
@manojag115 is attempting to deploy a commit to the Rohan Verma's projects Team on Vercel. A member of the Team first needs to authorize it. |
![recurseml[bot]](https://avatars.githubusercontent.com/in/1054195?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review by RecurseML
🔍 Review performed on 7ac7cd5..cd83a59
✨ No bugs found, your code is sparkling clean
✅ Files analyzed, no issues (24)
• MCP_FRONTEND_GUIDE.md
• MCP_IMPLEMENTATION.md
• surfsense_backend/alembic/versions/60_add_mcp_connector_type.py
• surfsense_backend/app/agents/new_chat/chat_deepagent.py
• surfsense_backend/app/agents/new_chat/tools/registry.py
• surfsense_backend/app/db.py
• surfsense_backend/app/routes/search_source_connectors_routes.py
• surfsense_backend/app/schemas/__init__.py
• surfsense_backend/app/schemas/search_source_connector.py
• surfsense_backend/app/tasks/chat/stream_new_chat.py
• surfsense_backend/app/utils/connector_naming.py
• surfsense_web/components/assistant-ui/connector-popup/components/connector-card.tsx
• surfsense_web/components/assistant-ui/connector-popup/connect-forms/index.tsx
• surfsense_web/components/assistant-ui/connector-popup/connector-configs/components/mcp-config.tsx
• surfsense_web/components/assistant-ui/connector-popup/connector-configs/index.tsx
• surfsense_web/components/assistant-ui/connector-popup/connector-configs/views/connector-connect-view.tsx
• surfsense_web/components/assistant-ui/connector-popup/constants/connector-constants.ts
• surfsense_web/components/assistant-ui/connector-popup/tabs/active-connectors-tab.tsx
• surfsense_web/components/assistant-ui/connector-popup/views/connector-accounts-list-view.tsx
• surfsense_web/contracts/enums/connector.ts
• surfsense_web/contracts/enums/connectorIcons.tsx
• surfsense_web/contracts/types/connector.types.ts
• surfsense_web/contracts/types/mcp.types.ts
• surfsense_web/lib/apis/connectors-api.service.ts
There was a problem hiding this comment.
Review by RecurseML
🔍 Review performed on cd83a59..774e8c7
✨ No bugs found, your code is sparkling clean
✅ Files analyzed, no issues (50)
• Dockerfile.allinone
• MCP_FRONTEND_GUIDE.md
• MCP_IMPLEMENTATION.md
• README.md
• README.zh-CN.md
• surfsense_backend/alembic/versions/5263aa4e7f94_allow_multiple_connectors_with_unique_.py
• surfsense_backend/alembic/versions/60_add_mcp_connector_type.py
• surfsense_backend/alembic/versions/60_add_surfsense_docs_tables.py
• surfsense_backend/alembic/versions/61_add_chat_visibility_and_created_by.py
• surfsense_backend/alembic/versions/ffd7445eb90a_add_is_active_to_search_source_.py
• surfsense_backend/app/agents/new_chat/system_prompt.py
• surfsense_backend/app/agents/new_chat/tools/__init__.py
• surfsense_backend/app/agents/new_chat/tools/mcp_client.py
• surfsense_backend/app/agents/new_chat/tools/mcp_tool.py
• surfsense_backend/app/agents/new_chat/tools/registry.py
• surfsense_backend/app/agents/new_chat/tools/search_surfsense_docs.py
• surfsense_backend/app/app.py
• surfsense_backend/app/db.py
• surfsense_backend/app/routes/__init__.py
• surfsense_backend/app/routes/new_chat_routes.py
• surfsense_backend/app/routes/rbac_routes.py
• surfsense_backend/app/routes/search_source_connectors_routes.py
• surfsense_backend/app/routes/surfsense_docs_routes.py
• surfsense_backend/app/schemas/__init__.py
• surfsense_backend/app/schemas/new_chat.py
• surfsense_backend/app/schemas/search_source_connector.py
• surfsense_backend/app/schemas/surfsense_docs.py
• surfsense_backend/app/tasks/chat/stream_new_chat.py
• surfsense_backend/app/tasks/surfsense_docs_indexer.py
• surfsense_backend/app/utils/connector_naming.py
• surfsense_backend/pyproject.toml
• surfsense_backend/scripts/seed_surfsense_docs.py
• surfsense_web/app/dashboard/[search_space_id]/documents/(manage)/components/DocumentsFilters.tsx
• surfsense_web/app/dashboard/[search_space_id]/documents/(manage)/components/DocumentsTableShell.tsx
• surfsense_web/app/dashboard/[search_space_id]/documents/(manage)/components/RowActions.tsx
• surfsense_web/app/dashboard/[search_space_id]/documents/(manage)/page.tsx
• surfsense_web/app/dashboard/[search_space_id]/editor/[documentId]/page.tsx
• surfsense_web/app/dashboard/[search_space_id]/new-chat/[[...chat_id]]/page.tsx
• surfsense_web/app/dashboard/[search_space_id]/settings/page.tsx
• surfsense_web/app/dashboard/[search_space_id]/team/page.tsx
• surfsense_web/app/dashboard/api-key/api-key-client.tsx
• surfsense_web/app/dashboard/api-key/client-wrapper.tsx
• surfsense_web/app/dashboard/api-key/page.tsx
• surfsense_web/app/dashboard/page.tsx
• surfsense_web/app/dashboard/searchspaces/page.tsx
• surfsense_web/app/dashboard/user/settings/page.tsx
• surfsense_web/atoms/chat/mentioned-documents.atom.ts
• surfsense_web/atoms/user/user-query.atoms.ts
• surfsense_web/components/assistant-ui/composer.tsx
• surfsense_web/components/assistant-ui/connector-popup.tsx
⏭️ Files skipped (57)
| Locations |
|---|
surfsense_web/components/assistant-ui/connector-popup/components/connector-status-badge.tsx |
surfsense_web/components/assistant-ui/connector-popup/config/connector-status-config.json |
surfsense_web/components/assistant-ui/connector-popup/connect-forms/components/mcp-connect-form.tsx |
surfsense_web/components/assistant-ui/connector-popup/connect-forms/index.tsx |
surfsense_web/components/assistant-ui/connector-popup/connector-configs/components/mcp-config.tsx |
surfsense_web/components/assistant-ui/connector-popup/connector-configs/index.tsx |
surfsense_web/components/assistant-ui/connector-popup/connector-configs/views/connector-edit-view.tsx |
surfsense_web/components/assistant-ui/connector-popup/constants/connector-constants.ts |
surfsense_web/components/assistant-ui/connector-popup/hooks/use-connector-dialog.ts |
surfsense_web/components/assistant-ui/connector-popup/tabs/active-connectors-tab.tsx |
surfsense_web/components/assistant-ui/connector-popup/views/connector-accounts-list-view.tsx |
surfsense_web/components/assistant-ui/document-upload-popup.tsx |
surfsense_web/components/assistant-ui/inline-citation.tsx |
surfsense_web/components/assistant-ui/inline-mention-editor.tsx |
surfsense_web/components/assistant-ui/markdown-text.tsx |
surfsense_web/components/assistant-ui/thread.tsx |
surfsense_web/components/assistant-ui/user-message.tsx |
surfsense_web/components/layout/index.ts |
surfsense_web/components/layout/providers/LayoutDataProvider.tsx |
surfsense_web/components/layout/types/layout.types.ts |
surfsense_web/components/layout/ui/dialogs/CreateSearchSpaceDialog.tsx |
surfsense_web/components/layout/ui/dialogs/index.ts |
surfsense_web/components/layout/ui/icon-rail/IconRail.tsx |
surfsense_web/components/layout/ui/icon-rail/SearchSpaceAvatar.tsx |
surfsense_web/components/layout/ui/icon-rail/WorkspaceAvatar.tsx |
surfsense_web/components/layout/ui/icon-rail/index.ts |
surfsense_web/components/layout/ui/index.ts |
surfsense_web/components/layout/ui/shell/LayoutShell.tsx |
surfsense_web/components/layout/ui/sidebar/AllNotesSidebar.tsx |
surfsense_web/components/layout/ui/sidebar/AllPrivateChatsSidebar.tsx |
surfsense_web/components/layout/ui/sidebar/AllSharedChatsSidebar.tsx |
surfsense_web/components/layout/ui/sidebar/MobileSidebar.tsx |
surfsense_web/components/layout/ui/sidebar/NoteListItem.tsx |
surfsense_web/components/layout/ui/sidebar/Sidebar.tsx |
surfsense_web/components/layout/ui/sidebar/SidebarHeader.tsx |
surfsense_web/components/layout/ui/sidebar/SidebarUserProfile.tsx |
surfsense_web/components/layout/ui/sidebar/index.ts |
surfsense_web/components/markdown-viewer.tsx |
surfsense_web/components/new-chat/chat-header.tsx |
surfsense_web/components/new-chat/chat-share-button.tsx |
surfsense_web/components/new-chat/document-mention-picker.tsx |
surfsense_web/components/new-chat/source-detail-panel.tsx |
surfsense_web/components/ui/context-menu.tsx |
surfsense_web/contracts/enums/connectorIcons.tsx |
surfsense_web/contracts/types/connector.types.ts |
surfsense_web/contracts/types/document.types.ts |
surfsense_web/contracts/types/mcp.types.ts |
surfsense_web/contracts/types/search-space.types.ts |
surfsense_web/lib/apis/base-api.service.ts |
surfsense_web/lib/apis/connectors-api.service.ts |
surfsense_web/lib/apis/documents-api.service.ts |
surfsense_web/lib/apis/search-spaces-api.service.ts |
surfsense_web/lib/chat/thread-persistence.ts |
surfsense_web/messages/en.json |
surfsense_web/messages/zh.json |
surfsense_web/package.json |
surfsense_web/pnpm-lock.yaml |
1 participant
Description
Backend:
Frontend:
Key Details:
Motivation and Context
FIX #625
Screenshots
API Changes
Change Type
Testing Performed
Checklist
High-level PR Summary
This PR introduces a Model Context Protocol (MCP) connector feature that allows users to define custom API endpoints as tools that the AI agent can invoke during conversations. The implementation includes a database migration to add the
MCP_CONNECTORtype, backend CRUD endpoints for managing MCP connectors with dynamic LangChain tool generation from JSON configurations, and a frontend UI for creating multi-tool connectors with support for multiple HTTP methods (GET, POST, PUT, PATCH, DELETE) and authentication types (Bearer, API Key, Basic Auth, None). Tools are loaded dynamically from the database on each chat session with permission-based access control, and the feature includes comprehensive documentation guides for both backend and frontend implementation.⏱️ Estimated Review Time: 30-90 minutes
💡 Review Order Suggestion
MCP_IMPLEMENTATION.mdMCP_FRONTEND_GUIDE.mdsurfsense_backend/alembic/versions/60_add_mcp_connector_type.pysurfsense_backend/app/db.pysurfsense_backend/app/schemas/search_source_connector.pysurfsense_backend/app/schemas/__init__.pysurfsense_web/contracts/enums/connector.tssurfsense_web/contracts/enums/connectorIcons.tsxsurfsense_web/contracts/types/connector.types.tssurfsense_web/contracts/types/mcp.types.tssurfsense_backend/app/agents/new_chat/tools/mcp_tool.pysurfsense_backend/app/agents/new_chat/tools/registry.pysurfsense_backend/app/routes/search_source_connectors_routes.pysurfsense_web/lib/apis/connectors-api.service.tssurfsense_web/components/assistant-ui/connector-popup/connect-forms/components/mcp-connect-form.tsxsurfsense_web/components/assistant-ui/connector-popup/connector-configs/components/mcp-config.tsxsurfsense_web/components/assistant-ui/connector-popup/connect-forms/index.tsxsurfsense_web/components/assistant-ui/connector-popup/connector-configs/index.tsxsurfsense_web/components/assistant-ui/connector-popup/connector-configs/views/connector-connect-view.tsxsurfsense_web/components/assistant-ui/connector-popup/constants/connector-constants.tssurfsense_backend/app/agents/new_chat/chat_deepagent.pysurfsense_backend/app/tasks/chat/stream_new_chat.pysurfsense_backend/app/utils/connector_naming.pysurfsense_web/components/assistant-ui/connector-popup/components/connector-card.tsxsurfsense_web/components/assistant-ui/connector-popup/tabs/active-connectors-tab.tsxsurfsense_web/components/assistant-ui/connector-popup/views/connector-accounts-list-view.tsx